<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GimpLayerMask: GIMP 3 Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GIMP 3 Library Reference Manual">
<link rel="up" href="libgimp-image.html" title="Manipulating Images and their Properties">
<link rel="prev" href="GimpLayer.html" title="gimplayer">
<link rel="next" href="GimpSelection.html" title="gimpselection">
<meta name="generator" content="GTK-Doc V1.33.0 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#GimpLayerMask.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GimpLayerMask.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="libgimp-image.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GimpLayer.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GimpSelection.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GimpLayerMask"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GimpLayerMask.top_of_page"></a>GimpLayerMask</span></h2>
<p>GimpLayerMask</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GimpLayerMask.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody><tr>
<td class="function_type">
<a class="link" href="GimpLayerMask.html" title="GimpLayerMask"><span class="returnvalue">GimpLayerMask</span></a> *
</td>
<td class="function_name">
<a class="link" href="GimpLayerMask.html#gimp-layer-mask-get-by-id" title="gimp_layer_mask_get_by_id ()">gimp_layer_mask_get_by_id</a> <span class="c_punctuation">()</span>
</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GimpLayerMask.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GObject
    <span class="lineart">╰──</span> <a class="link" href="GimpItem.html" title="gimpitem">GimpItem</a>
        <span class="lineart">╰──</span> <a class="link" href="GimpDrawable.html" title="gimpdrawable">GimpDrawable</a>
            <span class="lineart">╰──</span> <a class="link" href="GimpChannel.html" title="gimpchannel">GimpChannel</a>
                <span class="lineart">╰──</span> GimpLayerMask
</pre>
</div>
<div class="refsect1">
<a name="GimpLayerMask.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="GimpLayerMask.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gimp-layer-mask-get-by-id"></a><h3>gimp_layer_mask_get_by_id ()</h3>
<pre class="programlisting"><a class="link" href="GimpLayerMask.html" title="GimpLayerMask"><span class="returnvalue">GimpLayerMask</span></a> *
gimp_layer_mask_get_by_id (<em class="parameter"><code><span class="type">gint32</span> layer_mask_id</code></em>);</pre>
<p>Returns a <a class="link" href="GimpLayerMask.html" title="GimpLayerMask"><span class="type">GimpLayerMask</span></a> representing <em class="parameter"><code>layer_mask_id</code></em>
. This function
calls <a class="link" href="GimpItem.html#gimp-item-get-by-id" title="gimp_item_get_by_id ()"><code class="function">gimp_item_get_by_id()</code></a> and returns the item if it is
layer_mask or <code class="literal">NULL</code> otherwise.</p>
<div class="refsect3">
<a name="gimp-layer-mask-get-by-id.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>layer_mask_id</p></td>
<td class="parameter_description"><p>The layer_mask id.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-layer-mask-get-by-id.returns"></a><h4>Returns</h4>
<p>a <a class="link" href="GimpLayerMask.html" title="GimpLayerMask"><span class="type">GimpLayerMask</span></a> for
<em class="parameter"><code>layer_mask_id</code></em>
or <code class="literal">NULL</code> if <em class="parameter"><code>layer_mask_id</code></em>
does not
represent a valid layer_mask. The object belongs to
libgimp and you must not modify or unref it. </p>
<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.0</div>
</body>
</html>